Skip to main content

Endpoints

The Context API provides presigned URLs that consumers use to upload documents. For each document, the corresponding object key must be stored. To initiate processing, consumers submit the object keys along with the selected actions, some of which may require additional fields.

The following endpoints are provided by the Context API:

EndpointDescription
/actionsProvides list of the available extraction types available for consumers to execute on documents.
/processRequests extraction process execution for selected actions of choice and documents.
/presigned-urlProvides a presigned URL used for uploading document files.
 {id}/results 
Processes results retrieval.
/healthChecks availability of Context Service.

Downloadable Open API File

You can use the OpenAPI YAML file with tools such as Swagger to explore available endpoints and understand the request and response formats. Click Download to access the complete OpenAPI specification.